home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / tea100.zip / TEA100.DOC < prev    next >
Text File  |  1992-04-11  |  37KB  |  1,001 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                            The Electronic Alveary
  7.  
  8.            A word match program for crossword solvers and setters
  9.  
  10.  
  11.  
  12.                                      by
  13.  
  14.                               Ross Beresford
  15.  
  16.  
  17.  
  18.                                Version  1.00
  19.  
  20.                               12th April 1992
  21.  
  22.  
  23.  
  24.                     Copyright (c) J Ross Beresford 1992
  25.  
  26.                             All Rights Reserved
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                     The Electronic Alveary is a FREEWARE
  33.                     package: it can be freely copied and
  34.                     distributed under the terms of the
  35.                     licensing agreement at the end of
  36.                     this document.
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.         The program author can be reached on the following systems:
  47.  
  48.         CIX
  49.              Phone            +44 81 399 5252
  50.              Account name     rberesfo
  51.              Internet address rberesfo@cix.compulink.co.uk (preferred)
  52.                               rberesfo%cix@uknet.ac.uk (if above fails)
  53.  
  54.  
  55.         Golly!
  56.              Phone            +44 734 320812
  57.              Account name     Ross Beresford
  58.              Fidonet address  2:252/21
  59.              Internet address ross.beresford@f21.n252.z2.fidonet.org
  60.  
  61.  
  62.         MANIFEST
  63.         --------
  64.  
  65.         This release of TEA should contain the following files:
  66.  
  67.                 READ.ME         Quick start document
  68.                 TEA100.DOC      This manual
  69.                 TEA.EXE         The TEA pattern matching program
  70.                 TEA.RSC         The default (colour) configuration file
  71.                 COLOUR.RSC      Colour screen configuration file
  72.                 MONO.RSC        Monochrome screen configuration file
  73.                 WORDS.nn        TEA database files
  74.  
  75.         A compression program that builds TEA database files from an
  76.         ASCII word list is distributed separately as TEABDnnn.ZIP,
  77.         where nnn is the version number. This includes 'C' source and
  78.         an MS-DOS binary.
  79.  
  80.  
  81.         CONTENTS
  82.         --------
  83.  
  84.                 1. Introduction
  85.                 2. Interactive Mode
  86.                 3. Command Line Mode
  87.                 4. Patterns
  88.                 5. Controls
  89.                 Appendix A. Messages
  90.                 Appendix B. Video Modes
  91.                 Appendix C. Resource File
  92.                 Appendix D. Release History
  93.                 Appendix E. Licensing Information
  94.  
  95.  
  96.         1. INTRODUCTION
  97.            ------------
  98.  
  99.         TEA can be run in either command line mode or interactive
  100.         mode.
  101.  
  102.         The first two sections give information about how to use TEA
  103.         in each of these modes.
  104.  
  105.         The remaining sections describe the underlying functionality
  106.         of TEA which is the same for both modes.
  107.  
  108.         2. INTERACTIVE MODE
  109.            ----------------
  110.  
  111.         In this mode, TEA runs continuously and its behaviour is
  112.         controlled using a text mode user interface.
  113.  
  114.  
  115.         TEA determines the colours used in the interactive mode
  116.         display from a resource file. TEA is pre-configured for a
  117.         colour screen. If you have a monochrome screen, make sure TEA
  118.         uses the monochrome resource file before you start by typing:
  119.  
  120.                 copy mono.rsc tea.rsc
  121.  
  122.         See "Appendix C. Resource File" for more information about the
  123.         format of the resource file.
  124.  
  125.  
  126.         To enter interactive mode, just type the name of the program:
  127.  
  128.                 tea
  129.  
  130.         All the command line mode options may also be entered as
  131.         options when starting interactive mode: they become the
  132.         initial settings.
  133.  
  134.         By default, TEA assumes the dictionary database files are
  135.         named WORDS.nn and are stored in the same directory as
  136.         TEA.EXE. If you have moved the database files to a different
  137.         directory, or renamed them, you must use the -d option to
  138.         specify their path, for example:
  139.  
  140.                 tea -d d:\dict\words
  141.  
  142.         Once TEA has started, you can begin to enter match patterns
  143.         immediately. To exit TEA at this point, press Esc; pressing
  144.         Ctrl-C or Ctrl-Break at any time will also cause TEA to exit.
  145.  
  146.         See the PATTERNS section for a description of the types of
  147.         pattern that can be specified.
  148.  
  149.  
  150.         Help:             Once interactive mode has started, you can
  151.                           get help at any time by pressing F1.
  152.                           Pressing a key when the help screen is
  153.                           displayed returns you to the program.
  154.  
  155.  
  156.         Field editing:    The field being edited is displayed in a
  157.                           different colour. Characters can be entered
  158.                           at the cursor in the usual way.
  159.  
  160.                           The Ins key toggles between insert and
  161.                           overwrite mode (the default is insert mode);
  162.                           the Left and Right arrow keys move the
  163.                           cursor along a field; Home and End move the
  164.                           cursor to the beginning and end of a field;
  165.                           Del deletes the character at the cursor.
  166.  
  167.                           The Return key accepts a changed field; the
  168.                           Esc key causes any changes to be abandoned.
  169.  
  170.         Matching:         The program starts matching when Return is
  171.                           pressed after the pattern has been edited.
  172.  
  173.                           Matching can be paused by pressing any key.
  174.                           Pressing the space bar resumes the match;
  175.                           any other key aborts the match.
  176.  
  177.                           While matching is paused, the output buffer
  178.                           can be scrolled, printed or written to a
  179.                           file.
  180.  
  181.  
  182.         Scrolling output: If the matched output for a pattern
  183.                           overflows the output window, it is stored
  184.                           in a buffer up to a limit of 200 lines.
  185.  
  186.                           This buffer can be scrolled: a line at a
  187.                           time using the Up and Down arrow keys; a
  188.                           page at a time using PgUp and PgDn; to the
  189.                           top using Ctrl-PgUp and to the bottom using
  190.                           Ctrl-PgDn.
  191.  
  192.  
  193.         Printing output:  To print the contents of the output buffer,
  194.                           use ALT-W and then press Return.
  195.  
  196.  
  197.         Filing output:    To dump the contents of the output buffer to
  198.                           a file, press ALT-W, enter the name of the
  199.                           file to be created and then press return.
  200.  
  201.                           Note that the output buffer size is limited
  202.                           to 200 lines. If you want to dump large
  203.                           amounts of output (for example, all the
  204.                           words of a particular length), it is better
  205.                           to use command line mode and DOS file
  206.                           redirection.
  207.  
  208.  
  209.         Editing controls: The options affecting pattern matching are
  210.                           displayed just above the pattern in the TEA
  211.                           main screen. They can be changed by pressing
  212.                           ALT with the letter highlighted in the
  213.                           option name. Press:
  214.  
  215.                           ALT-S to change the shortest word length
  216.                           ALT-L to change the longest word length
  217.                           ALT-P to toggle the playfair filter setting
  218.                           ALT-A to change the alternate word filter
  219.                           ALT-I to change the included word filter
  220.  
  221.                           See the CONTROLS section for a description
  222.                           of how the controls affect pattern matching.
  223.  
  224.  
  225.         TEA tries to adapt to the active video mode when it starts up:
  226.         if the active video mode is one it supports (see "Appendix B:
  227.         Video Modes" for a list), then it con